Skip to content

docs: 로그인 로그아웃 api docs 추가 #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
sudhdkso merged 1 commit into from
Jul 15, 2025
Merged

docs: 로그인 로그아웃 api docs 추가 #6

sudhdkso merged 1 commit into from
Jul 15, 2025

Conversation

@sudhdkso
Copy link
Contributor

@sudhdkso sudhdkso commented Jul 15, 2025 •
edited by coderabbitai bot
Loading

#️⃣연관된 이슈

ex) #이슈번호, #이슈번호

🔀반영 브랜치

feat/#140-kakao-login

🔧변경 사항

  • 인증 관련 누락된 API와 로그아웃 안내를 문서에 반영했습니다.

💬리뷰 요구사항(선택)

리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요
ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요

Summary by CodeRabbit

  • Documentation

    • 인증 모듈 문서에 로그아웃 섹션이 추가되어 서비스 및 카카오 로그아웃 API 사용 방법이 상세히 안내됩니다.
    • 지출 이미지 URL 수정 관련 문서에 예시 및 스니펫이 보강되었습니다.
    • 인증 문서가 메인 API 문서에 포함되어 전체 문서 구조가 개선되었습니다.

  • Tests

    • 인증 및 지출 컨트롤러 테스트에 REST Docs 연동이 개선되어 쿠키 및 요청/응답 구조 문서화가 더욱 정확해졌습니다.

@sudhdkso sudhdkso self-assigned this Jul 15, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jul 15, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

문서화가 강화되어 인증 및 지출 API의 AsciiDoc 문서에 로그아웃과 이미지 URL 수정 관련 설명이 추가되었습니다. 메인 인덱스 문서에 인증 문서가 포함되었고, REST Docs 테스트 코드에서 쿠키와 관련된 문서화가 개선되었습니다. 일부 테스트에 REST Docs 연동이 추가되었습니다.

Changes

파일/경로 변경 요약
src/docs/asciidoc/auth.adoc 로그아웃(Logout) API 설명 및 예시 섹션 추가
src/docs/asciidoc/expense.adoc 지출 이미지 URL 수정 섹션에 operation 매크로 추가
src/docs/asciidoc/index.adoc auth.adoc 문서 인덱스에 포함
src/test/java/com/dnd/moddo/domain/auth/controller/AuthControllerTest.java REST Docs에서 쿠키 문서화로 개선, document 메서드 사용으로 변경
src/test/java/com/dnd/moddo/domain/expense/controller/ExpenseControllerTest.java saveExpensesSuccess, getAllByGroupIdSuccess에 REST Docs 문서화 추가

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Kakao

    Client->>API: 로그아웃 요청 (서비스)
    API-->>Client: 로그아웃 응답 (성공/실패)
    Client->>API: 로그아웃 요청 (카카오)
    API->>Kakao: 카카오 로그아웃 처리
    Kakao-->>API: 카카오 로그아웃 결과
    API-->>Client: 로그아웃 응답 (카카오)
Loading

Poem

🥕
문서에 로그아웃 길이 열렸네,
쿠키와 함께 REST Docs도 빛났네!
지출 이미지, 스니펫으로 척척,
테스트도 문서도 한층 더 단단해졌네.
토끼는 오늘도 귀 쫑긋,
변화의 발자국을 따라 깡총깡총!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between df33cc1 and 653f620.

📒 Files selected for processing (5)
  • src/docs/asciidoc/auth.adoc (1 hunks)
  • src/docs/asciidoc/expense.adoc (1 hunks)
  • src/docs/asciidoc/index.adoc (1 hunks)
  • src/test/java/com/dnd/moddo/domain/auth/controller/AuthControllerTest.java (4 hunks)
  • src/test/java/com/dnd/moddo/domain/expense/controller/ExpenseControllerTest.java (4 hunks)
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sudhdkso sudhdkso merged commit 8cf46fc into develop Jul 15, 2025
1 of 2 checks passed
@github-actions
Copy link

github-actions bot commented Jul 15, 2025

📝 테스트 커버리지 리포트입니다!

There is no coverage information present for the Files changed

Total Project Coverage 92.79% 🍏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@sudhdkso sudhdkso

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sudhdkso